/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.usergrid.chop.stack;


import java.util.List;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;


/**
 * Provider agnostic interface for IpPermissions.
 */
@JsonDeserialize( as = BasicIpRule.class )
public interface IpRule {

    @JsonProperty
    String getIpProtocol();

    @JsonProperty
    IpRule withIpProtocol( String ipProtocol );

    @JsonProperty
    Integer getFromPort();

    @JsonProperty
    IpRule withFromPort( Integer fromPort );

    @JsonProperty
    Integer getToPort();

    @JsonProperty
    IpRule withToPort( Integer toPort );

    @JsonProperty
    List<String> getIpRanges();

    @JsonProperty
    IpRule withIpRanges( String... ipRanges );
}
